<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    package org.bukkit.event.player;<a name="line.1"></a>
<FONT color="green">002</FONT>    <a name="line.2"></a>
<FONT color="green">003</FONT>    import java.net.InetAddress;<a name="line.3"></a>
<FONT color="green">004</FONT>    import org.bukkit.event.Event;<a name="line.4"></a>
<FONT color="green">005</FONT>    <a name="line.5"></a>
<FONT color="green">006</FONT>    /**<a name="line.6"></a>
<FONT color="green">007</FONT>     * Stores details for players attempting to log in<a name="line.7"></a>
<FONT color="green">008</FONT>     */<a name="line.8"></a>
<FONT color="green">009</FONT>    public class PlayerPreLoginEvent extends Event {<a name="line.9"></a>
<FONT color="green">010</FONT>        private Result result;<a name="line.10"></a>
<FONT color="green">011</FONT>        private String message;<a name="line.11"></a>
<FONT color="green">012</FONT>        private String name;<a name="line.12"></a>
<FONT color="green">013</FONT>        private InetAddress ipAddress;<a name="line.13"></a>
<FONT color="green">014</FONT>    <a name="line.14"></a>
<FONT color="green">015</FONT>        public PlayerPreLoginEvent(String name, InetAddress ipAddress) {<a name="line.15"></a>
<FONT color="green">016</FONT>            super(Type.PLAYER_PRELOGIN);<a name="line.16"></a>
<FONT color="green">017</FONT>            this.result = Result.ALLOWED;<a name="line.17"></a>
<FONT color="green">018</FONT>            this.message = "";<a name="line.18"></a>
<FONT color="green">019</FONT>            this.name = name;<a name="line.19"></a>
<FONT color="green">020</FONT>            this.ipAddress = ipAddress;<a name="line.20"></a>
<FONT color="green">021</FONT>        }<a name="line.21"></a>
<FONT color="green">022</FONT>    <a name="line.22"></a>
<FONT color="green">023</FONT>        /**<a name="line.23"></a>
<FONT color="green">024</FONT>         * Gets the current result of the login, as an enum<a name="line.24"></a>
<FONT color="green">025</FONT>         *<a name="line.25"></a>
<FONT color="green">026</FONT>         * @return Current Result of the login<a name="line.26"></a>
<FONT color="green">027</FONT>         */<a name="line.27"></a>
<FONT color="green">028</FONT>        public Result getResult() {<a name="line.28"></a>
<FONT color="green">029</FONT>            return result;<a name="line.29"></a>
<FONT color="green">030</FONT>        }<a name="line.30"></a>
<FONT color="green">031</FONT>    <a name="line.31"></a>
<FONT color="green">032</FONT>        /**<a name="line.32"></a>
<FONT color="green">033</FONT>         * Sets the new result of the login, as an enum<a name="line.33"></a>
<FONT color="green">034</FONT>         *<a name="line.34"></a>
<FONT color="green">035</FONT>         * @param result New result to set<a name="line.35"></a>
<FONT color="green">036</FONT>         */<a name="line.36"></a>
<FONT color="green">037</FONT>        public void setResult(final Result result) {<a name="line.37"></a>
<FONT color="green">038</FONT>            this.result = result;<a name="line.38"></a>
<FONT color="green">039</FONT>        }<a name="line.39"></a>
<FONT color="green">040</FONT>    <a name="line.40"></a>
<FONT color="green">041</FONT>        /**<a name="line.41"></a>
<FONT color="green">042</FONT>         * Gets the current kick message that will be used if getResult() != Result.ALLOWED<a name="line.42"></a>
<FONT color="green">043</FONT>         *<a name="line.43"></a>
<FONT color="green">044</FONT>         * @return Current kick message<a name="line.44"></a>
<FONT color="green">045</FONT>         */<a name="line.45"></a>
<FONT color="green">046</FONT>        public String getKickMessage() {<a name="line.46"></a>
<FONT color="green">047</FONT>            return message;<a name="line.47"></a>
<FONT color="green">048</FONT>        }<a name="line.48"></a>
<FONT color="green">049</FONT>    <a name="line.49"></a>
<FONT color="green">050</FONT>        /**<a name="line.50"></a>
<FONT color="green">051</FONT>         * Sets the kick message to display if getResult() != Result.ALLOWED<a name="line.51"></a>
<FONT color="green">052</FONT>         *<a name="line.52"></a>
<FONT color="green">053</FONT>         * @param message New kick message<a name="line.53"></a>
<FONT color="green">054</FONT>         */<a name="line.54"></a>
<FONT color="green">055</FONT>        public void setKickMessage(final String message) {<a name="line.55"></a>
<FONT color="green">056</FONT>            this.message = message;<a name="line.56"></a>
<FONT color="green">057</FONT>        }<a name="line.57"></a>
<FONT color="green">058</FONT>    <a name="line.58"></a>
<FONT color="green">059</FONT>        /**<a name="line.59"></a>
<FONT color="green">060</FONT>         * Allows the player to log in<a name="line.60"></a>
<FONT color="green">061</FONT>         */<a name="line.61"></a>
<FONT color="green">062</FONT>        public void allow() {<a name="line.62"></a>
<FONT color="green">063</FONT>            result = Result.ALLOWED;<a name="line.63"></a>
<FONT color="green">064</FONT>            message = "";<a name="line.64"></a>
<FONT color="green">065</FONT>        }<a name="line.65"></a>
<FONT color="green">066</FONT>    <a name="line.66"></a>
<FONT color="green">067</FONT>        /**<a name="line.67"></a>
<FONT color="green">068</FONT>         * Disallows the player from logging in, with the given reason<a name="line.68"></a>
<FONT color="green">069</FONT>         *<a name="line.69"></a>
<FONT color="green">070</FONT>         * @param result New result for disallowing the player<a name="line.70"></a>
<FONT color="green">071</FONT>         * @param message Kick message to display to the user<a name="line.71"></a>
<FONT color="green">072</FONT>         */<a name="line.72"></a>
<FONT color="green">073</FONT>        public void disallow(final Result result, final String message) {<a name="line.73"></a>
<FONT color="green">074</FONT>            this.result = result;<a name="line.74"></a>
<FONT color="green">075</FONT>            this.message = message;<a name="line.75"></a>
<FONT color="green">076</FONT>        }<a name="line.76"></a>
<FONT color="green">077</FONT>    <a name="line.77"></a>
<FONT color="green">078</FONT>        /**<a name="line.78"></a>
<FONT color="green">079</FONT>         * Gets the player's name.<a name="line.79"></a>
<FONT color="green">080</FONT>         *<a name="line.80"></a>
<FONT color="green">081</FONT>         * @return the player's name<a name="line.81"></a>
<FONT color="green">082</FONT>         */<a name="line.82"></a>
<FONT color="green">083</FONT>        public String getName() {<a name="line.83"></a>
<FONT color="green">084</FONT>            return name;<a name="line.84"></a>
<FONT color="green">085</FONT>        }<a name="line.85"></a>
<FONT color="green">086</FONT>    <a name="line.86"></a>
<FONT color="green">087</FONT>        /**<a name="line.87"></a>
<FONT color="green">088</FONT>         * Gets the player IP address.<a name="line.88"></a>
<FONT color="green">089</FONT>         *<a name="line.89"></a>
<FONT color="green">090</FONT>         * @return<a name="line.90"></a>
<FONT color="green">091</FONT>         */<a name="line.91"></a>
<FONT color="green">092</FONT>        public InetAddress getAddress() {<a name="line.92"></a>
<FONT color="green">093</FONT>            return ipAddress;<a name="line.93"></a>
<FONT color="green">094</FONT>        }<a name="line.94"></a>
<FONT color="green">095</FONT>    <a name="line.95"></a>
<FONT color="green">096</FONT>        /**<a name="line.96"></a>
<FONT color="green">097</FONT>         * Basic kick reasons for communicating to plugins<a name="line.97"></a>
<FONT color="green">098</FONT>         */<a name="line.98"></a>
<FONT color="green">099</FONT>        public enum Result {<a name="line.99"></a>
<FONT color="green">100</FONT>    <a name="line.100"></a>
<FONT color="green">101</FONT>            /**<a name="line.101"></a>
<FONT color="green">102</FONT>             * The player is allowed to log in<a name="line.102"></a>
<FONT color="green">103</FONT>             */<a name="line.103"></a>
<FONT color="green">104</FONT>            ALLOWED,<a name="line.104"></a>
<FONT color="green">105</FONT>            /**<a name="line.105"></a>
<FONT color="green">106</FONT>             * The player is not allowed to log in, due to the server being full<a name="line.106"></a>
<FONT color="green">107</FONT>             */<a name="line.107"></a>
<FONT color="green">108</FONT>            KICK_FULL,<a name="line.108"></a>
<FONT color="green">109</FONT>            /**<a name="line.109"></a>
<FONT color="green">110</FONT>             * The player is not allowed to log in, due to them being banned<a name="line.110"></a>
<FONT color="green">111</FONT>             */<a name="line.111"></a>
<FONT color="green">112</FONT>            KICK_BANNED,<a name="line.112"></a>
<FONT color="green">113</FONT>            /**<a name="line.113"></a>
<FONT color="green">114</FONT>             * The player is not allowed to log in, due to them not being on the white list<a name="line.114"></a>
<FONT color="green">115</FONT>             */<a name="line.115"></a>
<FONT color="green">116</FONT>            KICK_WHITELIST,<a name="line.116"></a>
<FONT color="green">117</FONT>            /**<a name="line.117"></a>
<FONT color="green">118</FONT>             * The player is not allowed to log in, for reasons undefined<a name="line.118"></a>
<FONT color="green">119</FONT>             */<a name="line.119"></a>
<FONT color="green">120</FONT>            KICK_OTHER<a name="line.120"></a>
<FONT color="green">121</FONT>        }<a name="line.121"></a>
<FONT color="green">122</FONT>    }<a name="line.122"></a>




























































</PRE>
</BODY>
</HTML>
